/*
 * Copyright 2009 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.splink.deepsplink.deeplink {
	import org.splink.library.IFinalizable;

	/**
	 * Encapsulates the actual javascript communication from deepsplink. 
	 * The default implementation is <code>SwfAddressDeeplinkStrategy</code>
	 * and uses the popular SWFAddress library.
	 * 
	 * @see org.splink.deepsplink.deeplink.SwfAddressDeeplinkStrategy
	 * 
	 * @author Max Kugland
	 */
	public interface IDeeplinkStrategy extends IFinalizable {

		/**
		 * Starts loading the first page 
		 */
		function start():void;
		
		/**
		 * Sets a callback method which is invoked after the <code>IDeeplinkStrategy</code>
		 * implementation performed the gotoPage command.
		 * 
		 * @param callback a callback function
		 */
		function setCallback(callback : Function) : void;
		
		/**
		 * @return the current address
		 */
		function getCurrentAddress() : String;
		
		/**
		 * Changes to the given pageId
		 */
		function gotoPage(pageId : String) : void;
	}
}
